/*
 * Copyright (c) 2017, Texas Instruments Incorporated - http://www.ti.com/
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the copyright holder nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * \file core/kernelentry.h
 * \brief KernelEntry
 */

#ifndef __KERNELENTRY_H__
#define __KERNELENTRY_H__

#include <CL/cl.h>
#include <CL/cl_ext.h>

#include <vector>
#include <string>

#include "kernel.h"

namespace Coal
{

/**
 * \brief Kernel Entry
 *
 * Represents a BuiltIn kernel, its arguments and its index corresponding to 
 * the device built-in function table. It is analogous to llvm::Function.
 * 
 * Usage:
 * ** In host deviceinterface to create BuiltIn kernels and then get a list of 
 *    created BuiltIn kernels
 * ** In accelerator device to instantiate supported BuiltIn kernels with
 *    required arguments
 *
 */
class KernelEntry
{
    public:
    KernelEntry(const std::string& name, cl_uint index);

    cl_uint addArg(unsigned short vec_dim, Kernel::Arg::File file,
                   Kernel::Arg::Kind kind, bool is_subword_int_uns);

    std::string name;
    std::vector<Kernel::Arg> args;
    cl_uint index;
};

}

#endif
